/config/app/health/monitor//description

Description for the health monitor.

Use

Use to create a description of the health monitor use and any other information.

Parameters

name: Name of health monitor

Data Key

The data key contains the description.

Data Type

string

Default Data Value

“”

Default Allowed

True

Request Methods

GET, PUT

Examples

GET

curl -b cookie.jar -k https://10.1.2.3:8443/lrs/api/v1.0/config/app/health/monitor/hm-01/description

GET Response

{"/config/app/health/monitor/hm-01/description": {"default": True,
                                                   "defaultAllowed": True,
                                                   "deleteAllowed": False,
                                                   "numChildren": 0,
                                                   "type": "string"},
 "httpResponseCode": 200,
 "recurse": False,
 "requestPath": "/config/app/health/monitor/hm-01/description"}

PUT

curl -b cookie.jar –data @data.json -k -H “Content-Type: application/json” -X PUT https://10.1.2.3:8443/lrs/api/v1.0/config/app/health/monitor/hm-01/description

PUT Response

{"httpResponseCode": 200,
  "requestPath": "/config/app/health/monitor/hm-01/description",
  "recurse":false}
  1. /config/app/health/monitor//description 1. Parameters 2. Data Key
    1. Data Type
    2. Default Data Value 3. Default Allowed 4. Request Methods 5. Related 6. Examples